Repository navigation
docs: polish the factory developer tool pages (audit 4/5) - #856
Draft
hongyi-chen wants to merge 9 commits into
Draft
hongyi-chen wants to merge 9 commits into
hongyi-chen wants to merge 9 commits into
Conversation
Reshape the factories overview from a launch-post structure into a technical overview: a concrete definition up front, one short section per part of a factory, sizing guidance, and related pages. Removes the "Who benefits", "What you get", product-table, and "Key terms" sections and the undefined "delivery policy" coinage. The #sizing-a-factory anchor that three pages link to is preserved. Aligns the opening definition on how-factories-work and the docs homepage with the overview, trims the diagram legend, cuts the salesy self-improvement framing, and adds the missing Related pages section. Co-Authored-By: Warp <agent@warp.dev> Co-Authored-By: Oz <oz-agent@warp.dev>
…w-copy # Conflicts: # src/content/docs/factories/how-factories-work.mdx # src/content/docs/factories/index.mdx # src/content/docs/index.mdx
Tighten the opening (drop "tools your team already uses"), make the component headings parallel, say "repeated failures" consistently, and note that benchmarks now compare harnesses as well as models and runners per #841. Co-Authored-By: Warp <agent@warp.dev> Co-Authored-By: Oz <oz-agent@warp.dev>
Add Microsoft Teams and Azure DevOps to the how-factories-work work sources legend so it matches the overview, and drop the restated consequence clause from the overview's Execution section in favor of naming what the infrastructure page covers. Co-Authored-By: Warp <agent@warp.dev> Co-Authored-By: Oz <oz-agent@warp.dev>
Same treatment as the factories overview: a concrete opener, three short lists of what Enterprise adds (administration, security and compliance, shared team configuration), role-based entry points, and related pages. Removes the "Who Warp Enterprise is for", "What this section covers", "Why enterprises choose Warp", and "Support and resources" sections and the marketing adjectives. Every retained claim was checked against the enterprise page it links to. Co-Authored-By: Warp <agent@warp.dev> Co-Authored-By: Oz <oz-agent@warp.dev>
This reverts commit ff03ffb.
Shorten the lead to two sentences, keep the CTA cards directly under it, and open a "What a factory does" section for the foreman, example, and human-checkpoint detail so the body is not an unbroken block of prose before the first H2. Rewrite the description so it stops repeating the lead paragraph it renders next to. Co-Authored-By: Warp <agent@warp.dev> Co-Authored-By: Oz <oz-agent@warp.dev>
Part 4 of 5 of the Warp Factories docs audit, split out of #852. Co-Authored-By: Warp <agent@warp.dev>
Collaborator
Author
|
This PR was generated with Warp. Comment |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Summary
Part 4 of 5 of the Warp Factories docs audit (split out of #852). Brings the Factory MCP tool table up to date and cleans up the API pages, which still carried the most GitBook-era formatting in the section.
Changes
factory-mcp.mdxlist_inbox,attach_integration, andstart_factory_learning(thefactory_learningflag is on in production). The learning phase itself has no page yet; that's a follow-up.api-and-sdk/index.mdxozcommands in examples (the page has none).---separators dropped.## Related pagessection is added. The bundled-skill table stays here as the single home.api-and-sdk/quickstart.mdxYOUR_API_KEY,ENV_ID,RUN_ID) per the style guide, with thewk-prefix fact kept in prose; "CI/CD" written out; Next steps use the quickstart shape (recap line, plain links).api-and-sdk/demo-sentry-monitoring-with-sdk.mdx## Turn production errors into draft pull requests) and an intro, then the video. The original###sat directly under the frontmatter H1, skipping a level, so it's an H2 now. Curly quotes, the "What Ben covers" pseudo-heading, and the arrow shorthand are gone; a## Related pagessection is added.factory-api.mdx,developer-tools.mdx,webhooks.mdx,webhooks/vercel.mdxfactory-api.mdx: the recap sentence after the endpoint-family table is cut; list items capitalize consistently; the SDK comment "With the pagination scheme wired" becomes plain English; "task" becomes "work item"; "adhoc" becomes "ad hoc".developer-tools.mdx: plain list links; "Webhooks" becomes "Custom webhooks" to match the page it links to.webhooks.mdx: the secret paragraph's dangling "which covers all three" is reworded; Related pages use plain links (also on the Vercel page).Content design plan
Audience and JTBD: A developer wiring a factory into their own tooling through MCP, the REST API, or a webhook.
Problem: The MCP table was missing three tools, and the API pages still read like the GitBook originals.
Goals: The tool table matches the server; the API pages follow the same conventions as the rest of the section.
Content type: Existing reference, quickstart, and feature pages; no new pages.
Unverified claims
None.
Documentation risk
Risk: engineering-review-required
Rationale: Adds three Factory MCP tools to the reference table; everything else is wording, formatting, and cross-links.
Source files consulted: warp-server/router/handlers/public_api/factory_mcp/server.go@cf7e9149d422, warp-server/config/prod.yaml@cf7e9149d422
Engineering review status: pending
Docs override: none
Validation
npm run build,check_links.py --internal-only(0 broken), andstyle_lint.pywere run on the combined audit branch that these files were split from.Plans:
Co-Authored-By: Warp agent@warp.dev